Product Entitlement Customer Experience API

Find the latest product release that is available for a given entitlement. Only one product release is returned. This one product release is the latest release.

Before you begin

You must do the following before you begin this task:

• Ensure you are permitted to make calls to the API by following the guidance in the Authentication topic.
• Import the Postman collection for the API by following the instruction in the Testing topic. You have a choice of using the sandbox or production API instance when setting up the Postman collection. The sandbox API is suitable for testing.

About this task

Each product release within an entitlement contains artifacts or files which you can download. This API request allows you to find the "latest" product release. You may use this API request to compare the current, latest product release against the latest product release returned on your last execution. If the release ids are different, it means there is a new release to download.

Procedure

1. Go to the imported Postman collection in your browser.
2. Click the arrow next to the name of your Postman collection in the left-hand menu to access a drop-down list of methods.
3. Select the GET /entitlements/{id}/rights/download/releases method.
4. Enter the entitlement id Path variable VALUE. You must use an entitlement id with "rightTo": "download". This API request will search for product releases the entitlement specified grants access to.
5. Enter the following search Query parameter VALUE: {"latestAvailable": true}.Parameters must be URL-encoded. For more information about URL-encoding, see Sending Parameters. The actual encoded value is: %7B%22latestAvailable%22%3A%20true%7D
6. Click the Send button in the top right of the GET /entitlements/{id}/rights/download/releases window.

Results

The example payload contains 1 product release which references the artifacts available for download.

The following is an example payload:

{
    "totalNumberOfItems": 1,
    "items": [
        {
            "id": "676e4d85-e67d-4dad-8733-f0e8d7eedd0b",
            "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/344470/releases/676e4d85-e67d-4dad-8733-f0e8d7eedd0b",
            "name": "DS5AC-r0p0-06rel16",
            "product": {
                "id": "DS5AC",
                "uri": "https://id.arm.com/product/products/DS5AC"
            },
            "revision": 0,
            "patch": 0,
            "majorVersion": 6,
            "minorVersion": 16,
            "quality": "rel",
            "type": "product",
            "createdAt": "2022-04-04T15:41:04Z",
            "availableAt": "2022-04-04T15:44:05.806Z",
            "artifacts": [
                {
                    "id": "8f034abb-b6d5-4f93-a1a3-2822ce419de8",
                    "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/344470/rights/download/releases/676e4d85-e67d-4dad-8733-f0e8d7eedd0b/artifact/8f034abb-b6d5-4f93-a1a3-2822ce419de8",
                    "name": "DS500-BN-00024-r5p0-18rel0",
                    "description": "Arm Compiler 6.16 for Windows 64-bit",
                    "type": "ip",
                    "fileName": "PDH UAT -DS500-BN-00024-r5p0-18rel0 \_6.16 Windows 64bit",
                    "fileSize": 411,
                    "md5": "84205f926217edf7e02bcc36afc5aff5"
                },
                {
                    "id": "7e4cf2a9-980a-4c06-a6c7-f2fb5f8c2b64",
                    "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/344470/rights/download/releases/676e4d85-e67d-4dad-8733-f0e8d7eedd0b/artifact/7e4cf2a9-980a-4c06-a6c7-f2fb5f8c2b64",
                    "name": "DS500-BN-00025-r5p0-18rel0",
                    "description": "ARM Compiler 6.16 for Windows 32-bit",
                    "type": "ip",
                    "fileName": "DS500-BN-00025-r5p0-18rel0.txt",
                    "fileSize": 27,
                    "md5": "03bf3632215ab95d89c8464a21e9c970"
                },
                {
                    "id": "aae93d2b-04b5-4f1d-8f99-d46f7b4c6aa5",
                    "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/344470/rights/download/releases/676e4d85-e67d-4dad-8733-f0e8d7eedd0b/artifact/aae93d2b-04b5-4f1d-8f99-d46f7b4c6aa5",
                    "name": "DS500-BN-00026-r5p0-18rel0",
                    "description": "Arm Compiler 6.16 for Linux 64-bit",
                    "type": "ip",
                    "fileName": "DS500-BN-00026-r5p0-18rel0.txt",
                    "fileSize": 26,
                    "md5": "2c6cf55ac40811d5a34aa0ac01044229"
                }
            ],
            "entitlement": {
                "id": "344470",
                "uri": "https://api.arm.com/e-product-entitlement-customer/v1/entitlements/344470"
            }
        }
    ]
}

Next steps

Go to GET /entitlements/{id}/rights/download/releases in the endpoint SPECIFICATION section for a full description of this API call.